Skip to content

docs(configuration): add Configuration Overhaul EPIC spec and 9 subissue specs (#1978)#1982

Merged
josecelano merged 2 commits into
torrust:developfrom
josecelano:configuration-overhaul-epic
Jul 15, 2026
Merged

docs(configuration): add Configuration Overhaul EPIC spec and 9 subissue specs (#1978)#1982
josecelano merged 2 commits into
torrust:developfrom
josecelano:configuration-overhaul-epic

Conversation

@josecelano

Copy link
Copy Markdown
Member

Summary

Planning and spec work for the Configuration Overhaul EPIC (#1978) — all configuration changes needed to release config schema v3.0.0 alongside tracker app v4.0.0.

This PR adds no code changes. It only adds/updates documentation spec files under docs/issues/.

What's included

New EPIC and subissue specs

Issue Spec file Description
#1978 1978-configuration-overhaul-epic.md EPIC: Configuration Overhaul (schema v3.0.0)
#1979 1979-1978-copy-configuration-schema-v2-to-v3-baseline.md Copy v2_0_0 → v3_0_0 as baseline (foundation)
#1980 1980-1978-configuration-overhaul-final-cleanup.md Final cleanup: remove global re-exports
#1981 1981-1978-fix-tsl-config-tls-config-typo.md Fix tsl_configtls_config typo (~21 files)

Updated pre-existing subissue specs (renamed to follow EPIC convention)

Issue Spec file Key changes
#889 889-1978-new-config-option-for-logging-style.md TraceStyle redesigned: DefaultFull, Pretty(bool)Pretty
#1415 1415-1978-use-service-binding-instead-of-socket-addr.md Scope narrowed: use existing ServiceBinding as-is
#1417 1417-1978-add-public-service-url-to-configuration.md Flat field (not inside Network); protocol validation
#1453 1453-1978-ip-bans-reset-interval-configurable.md New [udp_tracker_server] config section
#1490 1490-1978-decompose-database-config-and-overhaul-secrets.md Database decomposed into enum; secrecy crate
#1640 1640-1978-per-http-tracker-on-reverse-proxy-setting.md Full Network block per instance; public_url stays flat

Other

  • docs/issues/open/AGENTS.md — new file documenting filename conventions for the open/ folder
  • project-words.txt — added colour, reorganisation, zeroize

Implementation order

1 → 2 → 3 → 4 → 9   (critical path)
1 → 2 → 3 → 7 → 9   (critical path)

Subissues #5 (#1415), #6 (#1453), #8 (#889) are independent and can run in parallel.

Checklist

Copilot AI review requested due to automatic review settings July 15, 2026 10:31
@josecelano josecelano self-assigned this Jul 15, 2026
@josecelano
josecelano requested a review from da2ce7 July 15, 2026 10:31

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds planning/spec documentation for the Configuration Overhaul EPIC (config schema v3.0.0 alongside tracker app v4.0.0) under docs/issues/, plus supporting documentation for filename conventions and spellchecker dictionary updates.

Changes:

  • Added a new EPIC spec (#1978) and multiple subissue specs (new + renamed/updated) under docs/issues/open/.
  • Added docs/issues/open/AGENTS.md documenting filename conventions for issue specs.
  • Updated project-words.txt with additional terms needed by the new specs.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
project-words.txt Adds new dictionary words needed by the new/updated specs.
docs/issues/open/AGENTS.md Documents naming conventions for docs/issues/open/ spec files.
docs/issues/open/1978-configuration-overhaul-epic.md New EPIC spec describing goals, scope, ordering, and dependency graph.
docs/issues/open/1979-1978-copy-configuration-schema-v2-to-v3-baseline.md New subissue spec for creating the v3 baseline module.
docs/issues/open/1981-1978-fix-tsl-config-tls-config-typo.md New subissue spec for the mechanical tsl_*tls_* rename.
docs/issues/open/1640-1978-per-http-tracker-on-reverse-proxy-setting.md Updated/renamed subissue spec aligned to EPIC #1978 conventions and v3 paths.
docs/issues/open/1417-1978-add-public-service-url-to-configuration.md Updated spec moving from draft → open and clarifying public_url placement + validation.
docs/issues/open/1490-1978-decompose-database-config-and-overhaul-secrets.md New/updated subissue spec for DB config decomposition and adopting secrecy.
docs/issues/open/1453-1978-ip-bans-reset-interval-configurable.md New/updated subissue spec for configurable ban reset interval + de-duplicating cleanup job.
docs/issues/open/1415-1978-use-service-binding-instead-of-socket-addr.md New/updated subissue spec for switching identity plumbing from SocketAddr to ServiceBinding.
docs/issues/open/889-1978-new-config-option-for-logging-style.md New/updated subissue spec for TraceStyle redesign and thresholdtrace_filter.
docs/issues/open/1980-1978-configuration-overhaul-final-cleanup.md New subissue spec for removing global re-exports and migrating consumers to explicit versioned imports.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/issues/open/1980-1978-configuration-overhaul-final-cleanup.md Outdated
Comment thread docs/issues/open/1981-1978-fix-tsl-config-tls-config-typo.md Outdated
Comment thread docs/issues/open/1979-1978-copy-configuration-schema-v2-to-v3-baseline.md Outdated
Comment thread docs/issues/open/1490-1978-decompose-database-config-and-overhaul-secrets.md Outdated
Comment thread docs/issues/open/1490-1978-decompose-database-config-and-overhaul-secrets.md Outdated
Comment thread docs/issues/open/1490-1978-decompose-database-config-and-overhaul-secrets.md Outdated
Comment thread docs/issues/open/1490-1978-decompose-database-config-and-overhaul-secrets.md Outdated
Comment thread docs/issues/open/1415-1978-use-service-binding-instead-of-socket-addr.md Outdated
Comment thread docs/issues/open/1415-1978-use-service-binding-instead-of-socket-addr.md Outdated
Comment thread docs/issues/open/1980-1978-configuration-overhaul-final-cleanup.md Outdated
josecelano added a commit to josecelano/torrust-tracker that referenced this pull request Jul 15, 2026
- Fix stale spec filenames in progress log entries for issues torrust#1979,
  torrust#1980, and torrust#1981 (old intermediate names → correct final names)
- Replace .expose() with .expose_secret() in 4 places in spec torrust#1490
  (the correct secrecy crate API is ExposeSecret::expose_secret())
- Replace scheme() + bind_to() with protocol() + bind_address() in 2
  places in spec torrust#1415 (actual ServiceBinding API from torrust-net-primitives)
- Fix malformed markdown table in spec torrust#1980 where unescaped | in an
  rg command broke the table columns

Addresses review comments on PR torrust#1982.
…sue specs (torrust#1978)

Add planning and spec work for the Configuration Overhaul EPIC targeting
config schema v3.0.0 and tracker app v4.0.0.

New EPIC and subissue specs:
- 1978-configuration-overhaul-epic.md: EPIC spec for all config changes
- 1979-1978-copy-configuration-schema-v2-to-v3-baseline.md: copy v2→v3 baseline
- 1980-1978-configuration-overhaul-final-cleanup.md: final cleanup subissue
- 1981-1978-fix-tsl-config-tls-config-typo.md: fix tsl→tls typo subissue

Pre-existing open issues reviewed, refined, and linked to EPIC:
- 889-1978-new-config-option-for-logging-style.md (renamed with EPIC prefix)
- 1415-1978-use-service-binding-instead-of-socket-addr.md (new, from closed draft)
- 1417-1978-add-public-service-url-to-configuration.md (moved from drafts/, renamed)
- 1453-1978-ip-bans-reset-interval-configurable.md (new, linked to EPIC)
- 1490-1978-decompose-database-config-and-overhaul-secrets.md (new, linked to EPIC)
- 1640-1978-per-http-tracker-on-reverse-proxy-setting.md (renamed with EPIC prefix)

Also add docs/issues/open/AGENTS.md with file naming conventions for the
open/ folder, and extend project-words.txt with colour, colours,
reorganisation, and zeroize.
- Fix stale spec filenames in progress log entries for issues torrust#1979,
  torrust#1980, and torrust#1981 (old intermediate names → correct final names)
- Replace .expose() with .expose_secret() in 4 places in spec torrust#1490
  (the correct secrecy crate API is ExposeSecret::expose_secret())
- Replace scheme() + bind_to() with protocol() + bind_address() in 2
  places in spec torrust#1415 (actual ServiceBinding API from torrust-net-primitives)
- Fix malformed markdown table in spec torrust#1980 where unescaped | in an
  rg command broke the table columns

Addresses review comments on PR torrust#1982.
@josecelano
josecelano force-pushed the configuration-overhaul-epic branch from 4737f20 to dfe7b71 Compare July 15, 2026 11:03
@josecelano

Copy link
Copy Markdown
Member Author

ACK dfe7b71

@josecelano
josecelano merged commit 7e1fb72 into torrust:develop Jul 15, 2026
1 check passed
@josecelano
josecelano deleted the configuration-overhaul-epic branch July 15, 2026 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants